// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// Author: wsfuyibing <682805@qq.com>
// Date: 2024-12-05

package scheduler

import (
	"context"
	"gitee.com/gomq/sr/endpoint"
	"gitee.com/gomq/sr/message"
)

type (
	// Scheduler is an interface that used to dispatch received message to
	// subscription endpoint.
	//
	//	+------------------------------------------------------------------+
	//	| http  | dispatch by http request                                 |
	//	| https | dispatch by http request with ssl                        |
	//	| grpc  | dispatch by grpc request                                 |
	//	| ws    | dispatch by websocket                                    |
	//	| wss   | dispatch by websocket with ssl                           |
	//	+------------------------------------------------------------------+
	Scheduler interface {
		// Dispatch given message to given endpoint with given data. Parameter
		// data is equal to msg.Body if not a notification.
		Dispatch(ctx context.Context, ep endpoint.Endpoint, msg *message.Message, data []byte) Response
	}

	Releaser interface {
		// Release put scheduler instance into pool. You must call this
		// method when scheduler done.
		Release()
	}
)
